Public documentation site (loopy.writeit.ai)#59
Merged
Conversation
Records the plan and decisions for a self-hostable MDX documentation site for loopy-loop, published on loopy.writeit.ai. Follows orchestra's native @next/mdx pattern, styled to the WriteIt palette, with Pagefind + cmdk (Cmd+K) search, deployed to GitHub Pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Un4k1QPzatBWDgtRA1EvHh
Static MDX documentation site under website/, published to GitHub Pages at loopy.writeit.ai. Replicates orchestra's native @next/mdx pattern (page.mdx as routes), Tailwind v4 + typography themed to the WriteIt palette, Pagefind + cmdk (Cmd+K) search, and a GitHub Pages deploy workflow. - website/: Next.js App Router app, output: 'export', trailingSlash - 12 docs pages restructured from README/docs/design (current API, no SKILL drift) - WriteIt brand palette (sand/ink/green/gold/red); Hanken Grotesk (open font) - Pagefind static index + cmdk command palette (Cmd/Ctrl+K), scoped via data-pagefind-body - .github/workflows/docs-deploy.yml: build + Pagefind + actions/deploy-pages - public/CNAME + public/.nojekyll for the custom subdomain Verified: next build exports all 15 routes; Pagefind indexes 12 pages; local smoke test confirms rendering, Cmd+K search results, and navigation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Un4k1QPzatBWDgtRA1EvHh
Search (Pagefind + cmdk): - Resolve the Pagefind module via a fully-qualified origin URL so the dynamic import can't drift to the wrong base (fixed a real load failure). - Make searches race-safe with a monotonic request id; ignore stale/out-of-order resolutions and in-flight work after the dialog closes. - Add error/unavailable states; don't cache a failed init permanently. - Lowercase the Cmd/Ctrl+K key check (Caps Lock) and show a platform-aware hint. Accessibility: - Rebuild the mobile sidebar on Radix Dialog (focus trap, scroll lock, role/aria-modal, focus restoration). - Darken the text/interactive green to #2f7563 (WCAG AA on sand and with white); keep the vivid #5ca493 as a decorative --brand accent. Restore link underlines so color isn't the only cue. Other: - Route internal MDX links through next/link (client nav; avoids GitHub Pages 301s under trailingSlash). - Replace the broken 'next start' (invalid with output: export) with a static 'preview'. - Move workflow concurrency onto the deploy job so PR build-checks stay concurrent. - Document the required one-time GitHub Pages + DNS provisioning (an Actions deploy does not bind the domain from the artifact CNAME alone). Declined: importing MDX plugins as functions — Turbopack requires serializable string plugin names, so the string form is kept. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Un4k1QPzatBWDgtRA1EvHh
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a self-hostable MDX documentation site for
loopy-loop, to be published on loopy.writeit.ai.This PR starts with the design document capturing the plan and decisions, then implements the site itself in
website/.Design decisions (see
design/designs/documentation-site.md)@next/mdxpattern (page.mdx-as-route), not a new framework.website/in this repo, so docs version with the code (self-hostable module).loopy.writeit.aivia CNAME (static export, no server).cmdkfor a ⌘K command palette (static, self-hostable).docs/*/ design docs into MDX pages; reconcileSKILL.mddrift.Reviewers
Implementation reviewed by Codex and Antigravity; findings addressed in-branch.
Test plan
website/builds a static export (output: 'export') cleanly.nojekyllpresent🤖 Generated with Claude Code
https://claude.ai/code/session_01Un4k1QPzatBWDgtRA1EvHh